syntax-version=1
# This is a configuration file understood by the nCipher configuration     
# library, as well as being written automatically by some software         
# it can be edited manually. When manually editing this file, the following
# rules should be observed:                                                
#  o The syntax-version line must be first line of the file.               
#  o The file must only contain characters with ASCII values between 32 and
#    127 and \t, \r and \n.                                             
#  o Strings in the section-headers and field names are case sensitive.    
#  o field-value lines look like FIELDNAME=VALUE, white space before and   
#    after FIELDNAME and VALUE is harmless, it is stripped away by the     
#    configuration library.                                                
#  o Lines starting with a # are comments and ignored by the library, some 
#    comments are autogenerated by the library to assist in documenting    
#    the configuration options. Comments may be manually added to this     
#    file, however they might be overwritten if they are in a section that 
#    gets modified by a software utility.                                  
#  o If a section has multiple entries, each entry after the first is      
#    introduced by a line consisting of one or more hyphens ("-")        


[server_settings]
# Start of the server_settings section
# Hardserver settings which can be changed by calling hsc_serversettings with
# the hardserver running
# Each entry has the following fields:
#
# The hardserver's logging level, one of info, notice, client, remoteserver,
# error, serious, internal, startup, fatal, fatalinternal (default=info)
#  loglevel=STRING
#
# Level of detail to log, for diagnostics or debugging.
#  logdetail=FLAGS
#
# The maximum queue length for a remote connection between 1 and 4096
# (default=4096)
#  connect_maxqueue=INT
#
# Number of seconds to wait before retrying a remote connection (default=10)
#  connect_retry=INT
#
# Number of seconds between keepalive packets for remote connections
# (default=10)
#  connect_keepalive=INT
#
# Number of seconds before the first keepalive packet for remote outgoing
# connections (default=30)
#  connect_keepidle=INT
#
# Number of seconds the remote end may be unresponsive before a remote
# connection (incoming or outgoing) is considered broken (default=90)
#  connect_broken=INT
#
# After a netHSM has failed, how many seconds should the hardserver wait for
# it to become available again, before failing commands destined to the netHSM
# with a NetworkError message. For commands to have a chance of succeeding
# after a netHSM has failed, this value should be greater than connect_retry.
# If it is set to 0, then commands to the netHSM are failed with NetworkError
# immediately a netHSM has failed. (default = 35)
#  connect_command_block=INT
#
# Number of seconds before the first keepalive packet for remote incoming
# connections (default=30)
#  accept_keepidle=INT
#
# Number of seconds between keepalive packets for remote incoming connections.
# The socket will timeout after ten consecutive probe failures (default=10)
#  accept_keepalive=INT
#
# Maximum PCI interface version. 0 implies no limit. (default=0)
#  max_pci_if_vers=INT
#
# Is remote mode changing enabled on this system? (default=yes)
#  enable_remote_mode=ENUM
#
# Is remote reboot enabled on this system? (default=yes)
#  enable_remote_reboot=ENUM
#
# Is remote upgrade enabled on this system? (default=yes)
#  enable_remote_upgrade=ENUM
#
# Is remote appliance maintenance and diagnostics CLI enabled on this system?
# (default=yes)
#  enable_remote_cli=ENUM


[module_settings]
# Start of the module_settings section
# Per-module settings which can be changed by calling hsc_serversettings with
# the hardserver running
# Each entry has the following fields:
#
# Module ESN
#  esn=ESN
#
# Priority class of this module -- lower number is higher priority. (values
# 1-100, default 100)
#  priority=INT


[server_remotecomms]
# Start of the server_remotecomms section
# Hardserver IPv4 remote communication settings, these are only read at
# hardserver startup time
# Each entry has the following fields:
#
# The port for the hardserver to listen to for incoming impath connections or
# 0 for none (default=9004). Note that any firewall must be configured to
# allow connections to this port.
#  impath_port=PORT
#
# Specific IPv4 address the hardserver will bind to to listen for incoming
# impath connections. Default is 0.0.0.0 (i.e. INADDR_ANY).
#  impath_addr=ADDRESS
#
# Interface name (eth0, eth1, or bond0) the hardserver will bind to. Used if
# impath_addr is 0.0.0.0 (i.e. INADDR_ANY). Default (blank) is bind to all
# interfaces.
#  impath_interface=INTERFACE


[server_remotecomms_ipv6]
# Start of the server_remotecomms_ipv6 section
# Hardserver IPv6 remote communication settings, these are only read at
# hardserver startup time
# Each entry has the following fields:
#
# The port for the hardserver to listen to for incoming impath connections or
# 0 for none (default=9004). Note that any firewall must be configured to
# allow connections to this port.
#  impath_port=PORT
#
# Specific IPv6 address the hardserver will bind to to listen for incoming
# impath connections. Default is :: (i.e. in6addr_any).
#  impath_addr=ADDRESS
#
# Interface name (eth0, eth1, or bond0) the hardserver will bind to. It gets
# converted to the scope ID for link-local IP addresses.Used only if
# impath_addr is of link-local type (i.e. fe80::).
#  impath_interface=INTERFACE


[auditdb_settings]
# Start of the auditdb_settings section
# Hardserver settings for (new format v13.5 and later) nCore audit logging
# database.
# Each entry has the following fields:
#
# Minimum available megabytes of free-space for audit DB to operate.
# (default=0 for auto-configured)
#  free_space_min_mb=MB
#
# Maximum total size of audit DB in megabytes. (default=0 for no limit)
#  db_size_max_mb=MB
#
# Maximum number of audit indexes in audit DB. (default=0 for no limit))
#  audit_indexes_max=COUNT


[auditlog_settings]
# Start of the auditlog_settings section
# Legacy CEF audit only: Hardserver settings for audit logging.
# Each entry has the following fields:
#
# Legacy CEF audit only: Port number the audit logging syslog server listens
# to. (default=514)
#  auditlog_port=PORT
#
# Legacy CEF audit only: IP Address of the audit logging syslog server.
# (default=0.0.0.0)
#  auditlog_addr=ADDRESS
#
# Legacy CEF audit only: Copy audit log entries to hardserver log.
# (default=no)
#  auditlog_copy_hslog=ENUM


[server_startup]
# Start of the server_startup section
# Hardserver communication settings, these are only read at hardserver startup
# time
# Each entry has the following fields:
#
# Path of AF_UNIX domain socket to use for non-privileged connections on
# Windows and UNIX (default=/opt/nfast/sockets/nserver). Note that if the
# default value is present it will be substituted with the socket path under
# the actual installation location on the platform, i.e.
# NFAST_HOME/sockets/nserver.
#  unix_socket_name=STRING
#
# Path of AF_UNIX domain socket to use for privileged connections on Windows
# and UNIX (default=/opt/nfast/sockets/priv/privnserver). Note that if the
# default value is present it will be substituted with the socket path under
# the actual installation location on the platform, i.e.
# NFAST_HOME/sockets/priv/privserver.
#  unix_privsocket_name=STRING
#
# User or group allowed to issue non-privileged connections on windows or
# empty string for anyone (default="")
#  nt_pipe_users=STRING
#
# User or group allowed to issue privileged connections on windows or empty
# string for members of the Administrators group (default="")
#  nt_privpipe_users=STRING
#
# The port for the hardserver to listen to for local non-privileged TCP
# connections.Java clients default to connecting to 9000.When 0 is specified
# the port is disabled on UNIX, but enabled on port 9000 with the access
# controls specified by nt_pipe_users on Windows. (default=0)
#  nonpriv_port=PORT
#
# The port for the hardserver to listen to for local privileged TCP
# connections.Java clients default to connecting to 9001.When 0 is specified
# the port is disabled on UNIX, but enabled on port 9001 with the access
# controls specified by nt_privpipe_users on Windows. (default=0)
#  priv_port=PORT
#
# list of serial device nodes or COM ports for serial devices e.g COM1:COM2 or
# /dev/cua2:/dev/cua3 (default="")
#  serial_dtpp_devices=STRING
#
# The maximum number of file descriptors the hardserver can have open
# concurrently on Unix. The hardserver automatically configures its file
# descriptor soft limit up to the kernel hard limit. If this config entry is
# non-zero, the hardserver will set the soft limit to the requested value. The
# hardserver will refuse to start-up if it fails to set the new soft limit.
# This allows enforcement that the hardserver will be able to support, for
# example, a certain number of connections needed by client applications. If
# start-up fails, increase the kernel hard limit to be equal to or higher than
# the required number of file descriptors. (default=0)
#  unix_file_descriptor_max=INT


[server_performance]
# Start of the server_performance section
# Hardserver performance settings, these are only read at hardserver startup
# time
# Each entry has the following fields:
#
# Is multi-threaded performance scaling enabled on this system? (default=auto
# - auto means the hardserver will choose the best option for the available
# hardware).
#  enable_scaling=ENUM
#
# How much concurrent processing should the hardserver attempt to make use of
# for performance scaling? Applicable only when enable_scaling is set to yes.
# Auto-configured by the hardserver if set to 0; the target concurrency
# selected is written to the hardserver log. This does not restrict the
# hardserver to a particular number of cores, but if CPU availability is
# reduced by other applications, or if CPU affinity is enabled, reducing this
# setting below the auto-configured value may help improve performance. On
# systems with large numbers of CPU cores, if large numbers of client
# connections are made to the hardserver, or if large numbers of HSMs are
# used, increasing this value above the auto-configured default may help
# improve scaling. (default=0)
#  target_concurrency=INT


[nethsm_imports]
# Start of the nethsm_imports section
# The HSMs that the hardserver should import. Note that the limits listed here
# must be at least as strict as the HSM's own configuration, or the HSM will
# reject attempts to connect with ServerAccessDenied.
# Each entry has the following fields:
#
# New module number to assign to the imported nethsm, or 0 to use the next
# unassigned module number. (default=0)
#  local_module=INT
#
# Network address of the HSM
#  remote_ip=ADDR
#
# Port to connect to on the HSM
#  remote_port=PORT
#
# ESN of the HSM to import
#  remote_esn=ESN
#
# The hash of the key that the HSM should authenticate themselves with. If set
# to forty zeroes, key authentication is not performed (NOT RECOMMENDED).
#  keyhash=KEYHASH
#
# Whether to make a privileged connection to the HSM (default=0)
#  privileged=INT
#
# Whether to use high-numbered ports for privileged connections (default=0)
#  privileged_use_high_port=INT
#
# ESN of this client's nToken
#  ntoken_esn=ESN
local_module=0
remote_ip=10.10.10.60
remote_port=9004
remote_esn=33BE-C8AD-0DBF
keyhash=e48d776aa29a9d5354f5920fca577f5d0a519b6e
privileged=1
privileged_use_high_port=0
ntoken_esn=


[load_seemachine]
# Start of the load_seemachine section
# The SEE machines that the modules should load and possibly start for the
# benefit of other hardserver clients.
# Each entry has the following fields:
#
# The module to load the SEE machine onto
#  module=INT
#
# The filename of the SEE machine for this module to host. If this field is
# empty, and pull_rfs=yes is specified in an nShield Connect config file, any
# SEE machine and supporting userdata and femcerts files shall be deleted in
# the nShield Connect filesystem when the config file is pushed.
#  machine_file=STRING
#
# The ident of the seeconf key that protects the SEE machine. Only
# module-protected keys can be used here. If the machine is not encrypted then
# leave this field blank.
#  encryption_key=STRING
#
# The hash of the key that the SEE machine is signed by. This is only required
# if you are using the dynamic feature enable and the SEE machine is
# encrypted. (If the SEE machine is not encrypted then the signing key hash
# can be extracted from it automatically.)
#  signing_hash=KEYHASH
#
# The filename of the userdata to pass to the SEE machine on startup. If
# userdata is "" then the seemachine is loaded but not started. (default="").
#  userdata=STRING
#
# The PublishedObject name to use for publishing the KeyID of the started SEE
# machine. If worldid_pubname is "" then the KeyID is not published. This
# field is ignored if userdata is "". (default="").
#  worldid_pubname=STRING
#
# Program to run after loading the SEE machine to perform any initialisation
# required by the SEE machine or its clients, or "" if no initialisation is
# required. This program must accept an argument of the form "-m <module>".
# (default="").
#  postload_prog=STRING
#
# Args to pass to postload_prog, less '-m <module>' which will be
# automatically passed as the first argument. This field is ignored if
# postload_prog is "". (default="").
#  postload_args=STRING
#
# Set to "yes" to pull the SEE machine, userdata and femcerts from the RFS
# before loading on the remote module. (default=no)
#  pull_rfs=ENUM


[slot_imports]
# Start of the slot_imports section
# Remote slots that the hardserver should import to modules on this machine.
# Note that if a remote slot which has been remapped in the slot_mapping
# section on the remote system is to be imported, it must be referred to in
# this section by its new (post-mapping) remote_slotid.
# Each entry has the following fields:
#
# ESN of the local module to import the slot to
#  local_esn=ESN
#
# SlotID to use to refer to the slot when it is imported on the local module.
# Setting this value to 0 means it will be automatically assigned to the
# lowest available value. (default=0)
#  local_slotid=INT
#
# IP address of the machine hosting the slot to import
#  remote_ip=ADDR
#
# Port to connect to on the remote machine
#  remote_port=PORT
#
# ESN of the remote module to import the slot from
#  remote_esn=ESN
#
# SlotID of the slot to import on the remote module (default=0)
#  remote_slotid=INT


[slot_exports]
# Start of the slot_exports section
# Local slots that the hardserver should allow remote modules to import. Note
# that if a slot which has been remapped in the slot_mapping section is to be
# exported, it must be referred to in this section by its original
# (pre-mapping) local_slotid.
# Each entry has the following fields:
#
# ESN of the local module whose slot is allowed to be exported.
#  local_esn=ESN
#
# SlotID of the slot which is allowed to be exported. (default=0)
#  local_slotid=INT
#
# IP address of the machine allowed to import the slot or empty to allow all
# machines. (which is the default)
#  remote_ip=ADDR
#
# ESN of the module allowed to import the slot or "" to allow all modules
# which are permitted in the security world. (default ="")
#  remote_esn=ESN


[dynamic_slot_timeouts]
# Start of the dynamic_slot_timeouts section
# Timeout values used to specify expected smartcard responsiveness for all
# modules on the network.
# Each entry has the following fields:
#
# Round trip time limit, in seconds, is how long to wait before giving up due
# to network delays. (default=10)
#  round_trip_time_limit=INT
#
# Maximum time, in seconds, that can pass without a response from the
# smartcard before considering it removed and unloading all associated secrets
# (default=30)
#  card_remove_detect_time_limit=INT


[dynamic_slots]
# Start of the dynamic_slots section
# The dynamic smartcard slots that the modules should provide for the use of
# administrators who do not have physical access to the module hardware
# Each entry has the following fields:
#
# ESN of the module to be configured with dynamic slots.
#  esn=ESN
#
# Number of dynamic slots the module will support. (default=0)
#  slotcount=INT


[slot_mapping]
# Start of the slot_mapping section
# Slot remapping configuration. Notes for Remote Operator users: If a slot
# which is remapped in this section is also exported in the slot_exports
# section, the local_slotid field in the slot_exports section must be set to
# the original (pre-mapping) local_slotid. When importing that slot in another
# module, the slot_imports section must refer instead to the new
# (post-mapping) remote_slotid.
# Each entry has the following fields:
#
# ESN of the module on which slot 0 will be remapped with another.
#  esn=ESN
#
# Slot to exchange with slot 0. Setting this value to 0 means do
# nothing.(default=0)
#  slot=INT


[remote_file_system]
# Start of the remote_file_system section
# The remote file system volumes that this machine hosts for the benefit of
# HSMs. WARNING: This section is automatically written by the rfs-setup
# utility, it is recommended not to edit entries in this section.
# Each entry has the following fields:
#
# IP address of the machine allowed to access this volume or empty to allow
# any IP address. (which is the default)
#  remote_ip=ADDR
#
# ESN of the remote module allowed to access this volume or "" to allow any
# module (default="")
#  remote_esn=ESN
#
# The hash of the key that the machine must authenticate themselves with, or
# 40 zeros to indicate no key authentication required. (default=40 zeros)
#  keyhash=KEYHASH
#
# The local filename for the volume to which this entry corresponds
#  native_path=STRING
#
# The name of the volume which the remote host uses to access the files in
# native_path
#  volume=STRING
#
# Set to "yes" to allow a remote server to read the contents of a file in this
# volume. (default=no)
#  allow_read=ENUM
#
# Set to "yes" to allow a remote server to write the contents of a file in
# this volume. (default=no)
#  allow_write=ENUM
#
# Set to "yes" to allow a remote server to list the contents of a directory in
# this volume. (default=no)
#  allow_list=ENUM
#
# Set to "yes" if this volume represents a directory (default=no)
#  is_directory=ENUM
#
# Set to "yes" if files in this volume are text files which need to be opened
# in text mode. (default=no)
#  is_text=ENUM


[rfs_sync_client]
# Start of the rfs_sync_client section
# The remote file system that this client will synchronise its key management
# data files with.
# Each entry has the following fields:
#
# IP address of the RFS server to synchronise against.
#  remote_ip=ADDR
#
# Port to connect to the RFS server with (default 9004).
#  remote_port=PORT
#
# Set to 'yes' to use a local module KNETI to authenticate this client to the
# RFS. Otherwise the hardserver's software KNETI is used instead.
#  use_kneti=ENUM
#
# ESN of the local module to use for authentication (default = first module;
# only required if use_kneti=yes).
#  local_esn=ESN
#
# Software or module KNETI hash used to authenticate the RFS, or 40 zeroes to
# indicate no authentication required (default is 40 zeroes).
#  remote_keyhash=KEYHASH
#
# ESN of the remote module used to authenticate the RFS, or empty when using
# software KNETI authentication or no authentication required (default is
# empty).
#  remote_esn=ESN


[hs_clients]
# Start of the hs_clients section
# Allowed client IP addresses and permissions
# Each entry has the following fields:
#
# Allowed client IP address (unset by default)
#  addr=ADDR
#
# What types of commands can this client issue, one of "unpriv", "priv",
# "priv_lowport". (default "unpriv")
#  clientperm=TYPE
#
# The hash of the key that the client should authenticate itself with, or 40
# zeros to indicate no key authentication required.
#  keyhash=KEYHASH
#
# ESN of the client's nToken or empty if using software authentication.
#  esn=ESN


[remote_administration_service_startup]
# Start of the remote_administration_service_startup section
# Remote Administration Service communication settings, these are only read at
# Remote Administration Service startup time
# Each entry has the following fields:
#
# The port for the Remote Administration Service to listen on for incoming TCP
# connections from remote administration clients (default=9005)
#  port=PORT
